home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / propclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  2.0 KB  |  138 lines

  1. TABLE OF CONTENTS
  2.  
  3. propclass/--background--
  4. propclass/PGA_Arrows
  5. propclass/PGA_ArrowSize
  6. propclass/PGA_NoFrame
  7. propclass/PGA_ThinFrame
  8. propclass/PGA_XenFrame
  9.  
  10. propclass/--background--
  11.  
  12. NAME
  13.  
  14.     Class: propclass
  15.     Superclass: baseclass
  16.     Include File: <libraries/bgui.h>
  17.  
  18. FUNCTION
  19.  
  20.     To provide a BGUI compatible extension of the system propgclass. In
  21.     addition to the normal propgclass functionality you get the possibility
  22.     to add arrow gadgets to the object. Objects from this class send out the
  23.     following attribute pairs in notification events:
  24.  
  25.     GA_ID   - Gadget object ID.
  26.     PGA_Top - Top position of the prop knob.
  27.  
  28. NOTE
  29.  
  30.     All of the system propgclass attributes are also valid for this class.
  31.     Please refer to the documentation on the propgclass for more information
  32.     on these attributes.
  33.  
  34.  
  35. propclass/PGA_Arrows
  36.  
  37. NAME
  38.  
  39.     PGA_Arrows -- ( BOOL )
  40.  
  41. FUNCTION
  42.  
  43.     To determine whether or not the created object will get arrow gadgets
  44.     attached to the proportional gadget.
  45.  
  46. DEFAULT
  47.  
  48.     TRUE.
  49.  
  50. APPLICABILITY
  51.  
  52.     (I).
  53.  
  54. SEE ALSO
  55.  
  56.     PGA_ArrowSize
  57.  
  58. propclass/PGA_ArrowSize
  59.  
  60. NAME
  61.  
  62.     PGA_ArrowSize -- ( ULONG )
  63.  
  64. FUNCTION
  65.  
  66.     To determine the size of the arrows. The size affected is the height
  67.     of the arrows in vertical prop objects or the width of the arrows in
  68.     horizontal prop objects.
  69.  
  70. DEFAULTS
  71.  
  72.     10 horizontal and 9 vertical.
  73.  
  74. APPLICABILITY
  75.  
  76.     (I).
  77.  
  78. SEE ALSO
  79.  
  80.     PGA_Arrows
  81.  
  82. propclass/PGA_NoFrame
  83.  
  84. NAME
  85.  
  86.     PGA_NoFrame -- ( BOOL ) ** V40 **
  87.  
  88. FUNCTION
  89.  
  90.     To make a scroller object without a frame around the proportional
  91.     part of the object. Any attached arrows will keep framing.
  92.  
  93. DEFAULT
  94.  
  95.     FALSE.
  96.  
  97. APPLICABILITY
  98.  
  99.     (I).
  100.  
  101. propclass/PGA_ThinFrame
  102.  
  103. NAME
  104.  
  105.     PGA_ThinFrame -- ( BOOL )
  106.  
  107. FUNCTION
  108.  
  109.     To make all scroller object framing appear as thin frames. This will
  110.     help you to make an aspect-ratio dependant GUI.
  111.  
  112. DEFAULT
  113.  
  114.     FALSE.
  115.  
  116. APPLICABILITY
  117.  
  118.     (I).
  119.  
  120. propclass/PGA_XenFrame
  121.  
  122. NAME
  123.  
  124.     PGA_XenFrame -- ( BOOL )
  125.  
  126. FUNCTION
  127.  
  128.     To make all scroller object framing appear as Xen style framing.
  129.  
  130. DEFAULT
  131.  
  132.     FALSE.
  133.  
  134. APPLICABILITY
  135.  
  136.     (I).
  137.  
  138.